PokeKotlin API Reference

3.0.0-pre4

PokeKotlin API Reference/co.pokeapi.pokekotlin/PokeApi/Custom

Custom

class Custom(baseUrl: String = "https://pokeapi.co/", engine: HttpClientEngine = getDefaultEngine(), cacheStorage: CacheStorage? = null, configure: HttpClientConfig<*>.() -> Unit = {}) : PokeApi(source)

Constructors

constructor(baseUrl: String = "https://pokeapi.co/")

constructor(baseUrl: String = "https://pokeapi.co/", engine: HttpClientEngine = getDefaultEngine(), cacheStorage: CacheStorage? = null, configure: HttpClientConfig<*>.() -> Unit = {})

Functions

suspend fun <T : Model> Handle<T>.get(): T

suspend fun getAbility(id: Int): Ability

suspend fun getAbilityList(offset: Int, limit: Int): PaginatedList.Named<Ability>

suspend fun getBerry(id: Int): Berry

getBerryFirmness

suspend fun getBerryFirmness(id: Int): BerryFirmness

getBerryFirmnessList

suspend fun getBerryFirmnessList(offset: Int, limit: Int): PaginatedList.Named<BerryFirmness>

suspend fun getBerryFlavor(id: Int): BerryFlavor

getBerryFlavorList

suspend fun getBerryFlavorList(offset: Int, limit: Int): PaginatedList.Named<BerryFlavor>

suspend fun getBerryList(offset: Int, limit: Int): PaginatedList.Named<Berry>

getCharacteristic

suspend fun getCharacteristic(id: Int): Characteristic

getCharacteristicList

suspend fun getCharacteristicList(offset: Int, limit: Int): PaginatedList.Unnamed<Characteristic>

getContestEffect

suspend fun getContestEffect(id: Int): ContestEffect

getContestEffectList

suspend fun getContestEffectList(offset: Int, limit: Int): PaginatedList.Unnamed<ContestEffect>

suspend fun getContestType(id: Int): ContestType

getContestTypeList

suspend fun getContestTypeList(offset: Int, limit: Int): PaginatedList.Named<ContestType>

suspend fun getEggGroup(id: Int): EggGroup

getEggGroupList

suspend fun getEggGroupList(offset: Int, limit: Int): PaginatedList.Named<EggGroup>

getEncounterCondition

suspend fun getEncounterCondition(id: Int): EncounterCondition

getEncounterConditionList

suspend fun getEncounterConditionList(offset: Int, limit: Int): PaginatedList.Named<EncounterCondition>

getEncounterConditionValue

suspend fun getEncounterConditionValue(id: Int): EncounterConditionValue

getEncounterConditionValueList

suspend fun getEncounterConditionValueList(offset: Int, limit: Int): PaginatedList.Named<EncounterConditionValue>

getEncounterMethod

suspend fun getEncounterMethod(id: Int): EncounterMethod

getEncounterMethodList

suspend fun getEncounterMethodList(offset: Int, limit: Int): PaginatedList.Named<EncounterMethod>

getEvolutionChain

suspend fun getEvolutionChain(id: Int): EvolutionChain

getEvolutionChainList

suspend fun getEvolutionChainList(offset: Int, limit: Int): PaginatedList.Unnamed<EvolutionChain>

getEvolutionTrigger

suspend fun getEvolutionTrigger(id: Int): EvolutionTrigger

getEvolutionTriggerList

suspend fun getEvolutionTriggerList(offset: Int, limit: Int): PaginatedList.Named<EvolutionTrigger>

suspend fun getGender(id: Int): Gender

suspend fun getGenderList(offset: Int, limit: Int): PaginatedList.Named<Gender>

suspend fun getGeneration(id: Int): Generation

getGenerationList

suspend fun getGenerationList(offset: Int, limit: Int): PaginatedList.Named<Generation>

suspend fun getGrowthRate(id: Int): GrowthRate

getGrowthRateList

suspend fun getGrowthRateList(offset: Int, limit: Int): PaginatedList.Named<GrowthRate>

suspend fun getItem(id: Int): Item

getItemAttribute

suspend fun getItemAttribute(id: Int): ItemAttribute

getItemAttributeList

suspend fun getItemAttributeList(offset: Int, limit: Int): PaginatedList.Named<ItemAttribute>

getItemCategory

suspend fun getItemCategory(id: Int): ItemCategory

getItemCategoryList

suspend fun getItemCategoryList(offset: Int, limit: Int): PaginatedList.Named<ItemCategory>

getItemFlingEffect

suspend fun getItemFlingEffect(id: Int): ItemFlingEffect

getItemFlingEffectList

suspend fun getItemFlingEffectList(offset: Int, limit: Int): PaginatedList.Named<ItemFlingEffect>

suspend fun getItemList(offset: Int, limit: Int): PaginatedList.Named<Item>

suspend fun getItemPocket(id: Int): ItemPocket

getItemPocketList

suspend fun getItemPocketList(offset: Int, limit: Int): PaginatedList.Named<ItemPocket>

suspend fun getLanguage(id: Int): Language

getLanguageList

suspend fun getLanguageList(offset: Int, limit: Int): PaginatedList.Named<Language>

suspend fun getLocation(id: Int): Location

getLocationArea

suspend fun getLocationArea(id: Int): LocationArea

getLocationAreaList

suspend fun getLocationAreaList(offset: Int, limit: Int): PaginatedList.Named<LocationArea>

getLocationList

suspend fun getLocationList(offset: Int, limit: Int): PaginatedList.Named<Location>

suspend fun getMachine(id: Int): Machine

suspend fun getMachineList(offset: Int, limit: Int): PaginatedList.Unnamed<Machine>

suspend fun getMove(id: Int): Move

suspend fun getMoveAilment(id: Int): MoveAilment

getMoveAilmentList

suspend fun getMoveAilmentList(offset: Int, limit: Int): PaginatedList.Named<MoveAilment>

getMoveBattleStyle

suspend fun getMoveBattleStyle(id: Int): MoveBattleStyle

getMoveBattleStyleList

suspend fun getMoveBattleStyleList(offset: Int, limit: Int): PaginatedList.Named<MoveBattleStyle>

getMoveCategory

suspend fun getMoveCategory(id: Int): MoveCategory

getMoveCategoryList

suspend fun getMoveCategoryList(offset: Int, limit: Int): PaginatedList.Named<MoveCategory>

getMoveDamageClass

suspend fun getMoveDamageClass(id: Int): MoveDamageClass

getMoveDamageClassList

suspend fun getMoveDamageClassList(offset: Int, limit: Int): PaginatedList.Named<MoveDamageClass>

getMoveLearnMethod

suspend fun getMoveLearnMethod(id: Int): MoveLearnMethod

getMoveLearnMethodList

suspend fun getMoveLearnMethodList(offset: Int, limit: Int): PaginatedList.Named<MoveLearnMethod>

suspend fun getMoveList(offset: Int, limit: Int): PaginatedList.Named<Move>

suspend fun getMoveTarget(id: Int): MoveTarget

getMoveTargetList

suspend fun getMoveTargetList(offset: Int, limit: Int): PaginatedList.Named<MoveTarget>

suspend fun getNature(id: Int): Nature

suspend fun getNatureList(offset: Int, limit: Int): PaginatedList.Named<Nature>

suspend fun getPalParkArea(id: Int): PalParkArea

getPalParkAreaList

suspend fun getPalParkAreaList(offset: Int, limit: Int): PaginatedList.Named<PalParkArea>

getPokeathlonStat

suspend fun getPokeathlonStat(id: Int): PokeathlonStat

getPokeathlonStatList

suspend fun getPokeathlonStatList(offset: Int, limit: Int): PaginatedList.Named<PokeathlonStat>

suspend fun getPokedex(id: Int): Pokedex

suspend fun getPokedexList(offset: Int, limit: Int): PaginatedList.Named<Pokedex>

getPokemonColor

suspend fun getPokemonColor(id: Int): PokemonColor

getPokemonColorList

suspend fun getPokemonColorList(offset: Int, limit: Int): PaginatedList.Named<PokemonColor>

getPokemonEncounterList

suspend fun getPokemonEncounterList(id: Int): List<LocationAreaEncounter>

suspend fun getPokemonForm(id: Int): PokemonForm

getPokemonFormList

suspend fun getPokemonFormList(offset: Int, limit: Int): PaginatedList.Named<PokemonForm>

getPokemonHabitat

suspend fun getPokemonHabitat(id: Int): PokemonHabitat

getPokemonHabitatList

suspend fun getPokemonHabitatList(offset: Int, limit: Int): PaginatedList.Named<PokemonHabitat>

getPokemonShape

suspend fun getPokemonShape(id: Int): PokemonShape

getPokemonShapeList

suspend fun getPokemonShapeList(offset: Int, limit: Int): PaginatedList.Named<PokemonShape>

getPokemonSpecies

suspend fun getPokemonSpecies(id: Int): PokemonSpecies

getPokemonSpeciesList

suspend fun getPokemonSpeciesList(offset: Int, limit: Int): PaginatedList.Named<PokemonSpecies>

getPokemonVariety

suspend fun getPokemonVariety(id: Int): PokemonVariety

getPokemonVarietyList

suspend fun getPokemonVarietyList(offset: Int, limit: Int): PaginatedList.Named<PokemonVariety>

suspend fun getRegion(id: Int): Region

suspend fun getRegionList(offset: Int, limit: Int): PaginatedList.Named<Region>

suspend fun getStat(id: Int): Stat

suspend fun getStatList(offset: Int, limit: Int): PaginatedList.Named<Stat>

getSuperContestEffect

suspend fun getSuperContestEffect(id: Int): SuperContestEffect

getSuperContestEffectList

suspend fun getSuperContestEffectList(offset: Int, limit: Int): PaginatedList.Unnamed<SuperContestEffect>

suspend fun getType(id: Int): Type

suspend fun getTypeList(offset: Int, limit: Int): PaginatedList.Named<Type>

suspend fun getVersion(id: Int): Version

getVersionGroup

suspend fun getVersionGroup(id: Int): VersionGroup

getVersionGroupList

suspend fun getVersionGroupList(offset: Int, limit: Int): PaginatedList.Named<VersionGroup>

suspend fun getVersionList(offset: Int, limit: Int): PaginatedList.Named<Version>